﻿/// Copyright 2011 Timothy James
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///  http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
namespace IndexLibrary
{
    #region Enumerations

    /// <summary>
    /// Enum that specifies how a clause should be added to a query
    /// </summary>
    [System.CLSCompliant(true)]
    public enum ClauseOccurrence
    {
        /// <summary>
        /// Same as ShouldOccur
        /// </summary>
        Default = 0,

        /// <summary>
        /// Specifies that a clause must not occur in a result
        /// </summary>
        MustNotOccur = 1,

        /// <summary>
        /// Specifies that a clause must occur in a result
        /// </summary>
        MustOccur = 2,

        /// <summary>
        /// Specifies that a clause should occur in a result
        /// </summary>
        ShouldOccur = 3
    }

    #endregion Enumerations
}